Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation #44

Merged
merged 5 commits into from
Jan 30, 2019
Merged

Documentation #44

merged 5 commits into from
Jan 30, 2019

Conversation

bhilbert4
Copy link
Collaborator

This PR begins to add some basic coherent documentation in order to help the power users who are going to start playing with jwst_reffiles in the next week or so. There is still more that needs to be added, but hopefully I've covered the basics here.

@bhilbert4 bhilbert4 mentioned this pull request Jan 28, 2019
Open
@bhilbert4
Copy link
Collaborator Author

See #45 for a list of open questions that should be included in the documentation.

@bhilbert4
Copy link
Collaborator Author

Assuming that Armin is going to be the one to address the questions in #45, and that we probably don't want to deal with having him to push his changes to my branch before merging, my thought is that we should merge this and then have Armin open a new PR when he has time to answer those questions. @arminrest does that make sense to you? If so I'll probably ask @aliciacanipe or @bsunnquist to take a quick look at these docs to look for spelling/grammar/glaring omissions, and then merge when they are happy.

@bhilbert4
Copy link
Collaborator Author

If you want to see the documentation on a webpage rather than just looking at text files, after you pull this branch, go into the docs subdirectory and do make html. Then the files should appear in the _build/html subdirectory.

bsunnquist
bsunnquist reviewed Jan 29, 2019
View reviewed changes
Copy link
Collaborator

@bsunnquist bsunnquist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! I just had some minor grammar and installation/setup instruction suggestions.

docs/configuration_files.rst Show resolved Hide resolved
docs/configuration_files.rst Show resolved Hide resolved
docs/configuration_files.rst Outdated Show resolved Hide resolved
docs/configuration_files.rst Outdated Show resolved Hide resolved
docs/configuration_files.rst Outdated Show resolved Hide resolved
docs/configuration_files.rst Show resolved Hide resolved
docs/install.rst Show resolved Hide resolved
docs/install.rst Show resolved Hide resolved
docs/install.rst Show resolved Hide resolved
docs/organize_input_files.rst Outdated Show resolved Hide resolved
@bhilbert4
Copy link
Collaborator Author

Thanks for the comments @bsunnquist! I think I addressed all of them, and I added in some clarifying text from Armin as well.

If you're happy, could you hit Approve for the review and I'll merge?

bsunnquist
bsunnquist approved these changes Jan 30, 2019
View reviewed changes
Copy link
Collaborator

@bsunnquist bsunnquist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good to me!

@bhilbert4 bhilbert4 merged commit 2779166 into spacetelescope:master Jan 30, 2019
@bhilbert4 bhilbert4 deleted the documentation branch January 30, 2019 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bsunnquist bsunnquist bsunnquist approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@bhilbert4 @bsunnquist